JxBrowser/com.teamdev.jxbrowser.dsl.engine/[jvm]OptionsDsl

OptionsDsl

class OptionsDsl(builder: EngineOptions.Builder)

Configures options for Engine.

Since

8.0.0

Constructors

constructor(builder: EngineOptions.Builder)

Properties

autoplayEnabled

var autoplayEnabled: Boolean

Allows automatic starting of video and audio playbacks.

var chromiumDir: Path

Sets the absolute path to the directory where Chromium binaries are located.

var diskCacheSize: Long

Sets the disk cache size, in bytes.

dnsQuickCheckDisabled

var dnsQuickCheckDisabled: Boolean

Disables DNS quick check.

fileAccessFromFilesAllowed

var fileAccessFromFilesAllowed: Boolean

Allows the file:// URIs to read other file:// URIs.

val google: GoogleDsl

Configures Google credentials.

var gpuDisabled: Boolean

Disables GPU rendering.

incognitoEnabled

var incognitoEnabled: Boolean

Enables the incognito mode for the default profile.

var language: Language

Sets the Chromium language, which is used on the default error pages and message dialogs.

var license: JxBrowserLicense

Sets the license key required to perform operations with the engine.

mediaRoutingEnabled

var mediaRoutingEnabled: Boolean

Enables media routing.

var passwordStore: PasswordStore

Sets the password store type that specifies, which storage backend to use to encrypt cookies on Linux.

proprietaryFeatures

var proprietaryFeatures: Set<ProprietaryFeature>

List of proprietary features to enable.

remoteDebuggingPort

var remoteDebuggingPort: Int

Sets the remote debugging port.

rendererHangTimeout

var rendererHangTimeout: Duration

Sets how long the renderer can be unresponsive before it is considered hung.

sandboxDisabled

var sandboxDisabled: Boolean

Disables the Chromium sandbox.

val schemes: SchemesDsl

Associates the given URL schemes with the callbacks, so that all URL requests with the given schemes will be intercepted before they are sent out.

var secureOrigins: List<String>

Adds the given origins to the white list, so that they will be treated as secure origins.

var switches: List<String>

List of switches that will be passed to the Chromium process.

touchMenuDisabled

var touchMenuDisabled: Boolean

Disables the popup menu, which is displayed when a user performs long press on the touch screen.

var userAgent: UserAgent

Sets the custom user agent string, which is used to override engine's default user agent.

var userDataDir: Path

Sets the absolute path to the directory where the user data is stored.

webSecurityDisabled

var webSecurityDisabled: Boolean

Disables the same-origin policy.

Functions

fun google(configuration: GoogleDsl.() -> Unit)

Configures Google credentials.

fun schemes(configuration: SchemesDsl.() -> Unit)

Associates the given URL schemes with the callbacks, so that all URL requests with the given schemes will be intercepted before they are sent out.